home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / joked_02.zip / SHROOM.ZIP / SHROOM.DOC < prev   
Text File  |  1990-12-11  |  4KB  |  108 lines
  1.  
  2.     shroom.doc    - readme file for Shell Room Utility
  3.  
  4.     Copyright (C) Davis Augustine 1990.  All rights reserved.
  5.  
  6.     Last Modified: 11dec90
  7.  
  8. Files
  9. -----
  10.     SHROOM.COM    - The program.
  11.     SHROOM.DOC    - This documentation file.
  12.  
  13. Description
  14. -----------
  15.     SHROOM is a utility that gives a DOS application's shells more
  16.     room.  It does this by intercepting the shell operation,
  17.     swapping out the application program, freeing up the memory,
  18.     and then performing the shell operation.  It also
  19.     intercepts the exit from the shell, so that it can swap
  20.     the application back in before returning to it.  The program
  21.     is none the wiser.
  22.  
  23. Features
  24. --------
  25.      o    Easy to use.
  26.      o    Detects swap file overflow (disk full) and asks whether you want
  27.     to abort back to the application or continue with a partial swap.
  28.      o    Detects TSR loading and unloading during the shell.  Frees
  29.     the TSR's resources and puts a warning message.
  30.      o    Small resident size (under 6k).  Frees nearly all of the memory.
  31.      o    Works with all major DOS applications.
  32.      o    Fully user specifiable swap file path.    Ie., you can put
  33.     it on a virtual disk.
  34.      o    Swaps allocated memory only, avoiding unnecessary writes
  35.     and reads of free memory.
  36.      o    Intelligent command line parsing.  Searches DOS's PATH
  37.     for program to load, allows passing of args to the program.
  38.     Automatically tries .COM and .EXE extensions if not
  39.     specified by user.
  40.      o    Verbose mode for inquisitive users.
  41.      o    Uses DOS "make temp file" facility to prevent network clashes.
  42.  
  43.  
  44. Installation and Operation
  45. --------------------------
  46.      o    To install, just copy SHROOM.COM into a directory in your PATH
  47.     or the directory from which you will run the application.
  48.      o    For help, use the question mark switch, eg. "shroom -?".
  49.      o    To load, just type the normal command used to invoke the
  50.     application, with "shroom " prepended.  Eg, if the application
  51.     is called "edit", then you would use the command "shroom edit".
  52.     Arguments are passed to the application just as before, so eg.
  53.     you can say "shroom edit letter.doc".
  54.      o    To shell out, use whatever shell command is provided by the
  55.     application.  You will see a message from Shroom saying that it
  56.     is swapping the program out, after which the normal shell prompt
  57.     and actions will appear.  When you exit the shell, you will
  58.     again see the "swapping" message from Shroom and then be
  59.     deposited back into the application as usual.
  60.  
  61.  
  62. Help Screen - Displayed by the "-?" switch:
  63. -------------------------------------------
  64.  
  65. Usage:     shroom [-?hLv] [-s path] prog [args]
  66.        -?h : print this help message
  67.     -L : display shareware license
  68.     -v : verbose mode
  69.  [-s path] : specify DRIVE:DIR in which to create swap file
  70.       prog : application program to execute
  71.     [args] : command line to pass to the application
  72.  
  73.   NOTES:
  74.     o The application can be any .EXE or .COM file.
  75.     o Shroom first tries to load the application program from the current
  76.       directory, and then it searches the PATH.
  77.     o Works with PharLap DOS Extender based applications.
  78.     o Not compatible with Quarterdeck's DesqView, Microsoft's Windows or
  79.       other DOS multitasking software.
  80.  
  81.  
  82. Shareware License - Displayed by the "-L" switch:
  83. -------------------------------------------------
  84.  
  85.       ********** SHROOM SHAREWARE LICENSE **********
  86.  
  87.  This is a copyrighted software work which is distributed as shareware.
  88.  Under this license agreement you are granted the right to use Shroom
  89.  on all machines and environments that it supports.  You are also
  90.  free (and encouraged) to pass copies of this shareware on to others
  91.  as long as it is not for payment and not bundled with anything else
  92.  that is for payment.
  93.  
  94.  If you find Shroom useful and worth the investment, please send a
  95.  registration fee by check or money order of $20 for individual users
  96.  or $75 for groups (up to 10 users) to:
  97.  
  98.            Davis Augustine
  99.            P.O. Box 390178
  100.            Cambridge, MA. 02139
  101.  
  102.  Commercial distribution licenses, source code and customized versions
  103.  are also available at reasonable rates.  Please write to the above address
  104.  or send me email at Compuserve id 72230,3053.    I would also appreciate any
  105.  comments, questions, suggestions or bug reports.
  106.  
  107.  
  108.